/*
 * Copyright (C) 2021 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.sentry;

import io.sentry.protocol.SentryTransaction;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

/**
 * An Event Processor that may mutate or drop an event. Runs for SentryEvent or SentryTransaction
 *
 * @since 2021-06-02
 */
public interface EventProcessor {
    /**
     * May mutate or drop a SentryEvent
     *
     * @param event the SentryEvent
     * @param hint the Hint
     * @return the event itself, a mutated SentryEvent or null
     */
    @Nullable
    default SentryEvent process(@NotNull SentryEvent event, @Nullable Object hint) {
        return event;
    }

    /**
     * May mutate or drop a SentryTransaction
     *
     * @param transaction the SentryTransaction
     * @param hint the Hint
     * @return the event itself, a mutated SentryTransaction or null
     */
    @Nullable
    default SentryTransaction process(@NotNull SentryTransaction transaction, @Nullable Object hint) {
        return transaction;
    }
}
